/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.druid.frame.segment.row;

import org.apache.druid.frame.write.RowBasedFrameWriter;

/**
 * Pointer to a row position in some memory. The memory itself is handled separately, and generally comes from
 * region {@link RowBasedFrameWriter#ROW_DATA_REGION} of a row-based frame.
 *
 * Each row pointed-to by this pointer is in the row-based frame format documented at
 * {@link org.apache.druid.frame.field.RowReader}.
 */
public interface ReadableFrameRowPointer
{
  /**
   * Position of the start of the row relative to the start of the Frame
   */
  long position();

  /**
   * Length of the row (in bytes)
   */
  long length();
}
